Skip to main content
Version: 2.0

List Message

To send a list message, you must assemble an interactive object of type list with the following components:

ObjectDescription
headerOptional.
If you decide to include it, you must set the header’s type to text and add a text field with the desired content. Maximum of 60 characters.
bodyRequired.
Your message’s body. Maximum of 1024 characters.
footerOptional.
Your message’s footer.
actionRequired.
Inside action, you must nest:
- a button field with your button’s content, maximum of 20 characters
- at least one section object (maximum of 10) with a maximum of 24 characters for the title for section

Inside section, you must add at least one rows object. Maximum of 24 characters for the title for a row and maximum of 72 characters for the description for a row.

Payload

{
"recipient_type": "individual",
"to": "918892532751",
"type": "interactive",
"interactive": {
"type": "list",
"header": {
"type": "text",
"text": "hello there"
},
"body": {
"text": "abcd"
},
"footer": {
"text": "abcd"
},
"action": {
"button": "Submit",
"sections": [
{
"title": "aa",
"rows": [
{
"id": "id1",
"title": "row-title-content"
}
]
},
{
"title": "sa",
"rows": [
{
"id": "id2",
"title": "row-title-content"
}
]
}
]
}
},
"metadata": {
"messageId": "xxxxx",
"transactionId": "xxxxx",
"callbackDlrUrl": "https:xxx.com",
}
}

Note : Calback URL is a optional paramter . Please use when you want to change the default URL(configured through smartta). It will only chnage the domain name othere paratemters will be same as configurated in smartta.